internals rewrite: clean up checks and hypothesis functionality #1109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #1109 +/- ##
==========================================
+ Coverage 97.23% 97.41% +0.17%
==========================================
Files 63 67 +4
Lines 4710 4789 +79
==========================================
+ Hits 4580 4665 +85
+ Misses 130 124 -6
... and 3 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
This was referenced Mar 13, 2023
|
this PR is part 2 in the effort to decouple pandas-specific validation logic from the pandera schema specification: #381 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR organizes the checks and hypothesis modules across the
coreandbackendsubpackages for overall consistency:pandera.core.{checks, hypotheses}module specifies the public-facing class API for checks and hypotheses. This provides a way for users to access built-in checks/hypotheses with full auto-completion on an IDE. These methods delegate to thebuiltin_{checks, hypotheses}modules.pandera.backends.base.builtin_{checks, hypotheses}modules implement base function implementations that usemultimethodto dispatch the implementation to a specific data framework (e.g.pandera.backends.pandas.builtin_{checks, hypotheses}@{Check, Hypothesis}.register_builtin_check_fn, and framework-specific implementations are marked with@register_builtin_{check, hypothesis}This PR also cleans up the way
SchemaErrorsfailure cases are handled. Instead of having pandas-specific logic in theSchemaErrorsmethods:failure_cases_metadatamethod was introduced in theBaseSchemaBackendclass to handle consolidating and summarizing failure cases from across multiple checks.FailureCaseMetadatanamedtuple class to clarify the metadata needed bySchemaErrors.